<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AceCRC: /home/brian/src/AceCRC/src/AceCRC.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">AceCRC
   &#160;<span id="projectnumber">1.1.1</span>
   </div>
   <div id="projectbrief">Cyclic Redundancy Check (CRC) algorithms (e.g. crc16ccitt, crc32) programmatically converted from C99 code generated by pycrc (https://pycrc.org) to Arduino C++ using namespaces and PROGMEM flash memory.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">AceCRC.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * MIT License</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright (c) 2020 Brian T. Park</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef ACE_CRC_ACE_CRC_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define ACE_CRC_ACE_CRC_H</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc8__bit_8hpp.html">ace_crc/crc8_bit.hpp</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc8__byte_8hpp.html">ace_crc/crc8_byte.hpp</a>&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc8__nibble_8hpp.html">ace_crc/crc8_nibble.hpp</a>&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc8__nibblem_8hpp.html">ace_crc/crc8_nibblem.hpp</a>&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc16ccitt__bit_8hpp.html">ace_crc/crc16ccitt_bit.hpp</a>&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc16ccitt__byte_8hpp.html">ace_crc/crc16ccitt_byte.hpp</a>&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc16ccitt__nibble_8hpp.html">ace_crc/crc16ccitt_nibble.hpp</a>&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc16ccitt__nibblem_8hpp.html">ace_crc/crc16ccitt_nibblem.hpp</a>&quot;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc16modbus__bit_8hpp.html">ace_crc/crc16modbus_bit.hpp</a>&quot;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc16modbus__byte_8hpp.html">ace_crc/crc16modbus_byte.hpp</a>&quot;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc16modbus__nibble_8hpp.html">ace_crc/crc16modbus_nibble.hpp</a>&quot;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc16modbus__nibblem_8hpp.html">ace_crc/crc16modbus_nibblem.hpp</a>&quot;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc32__bit_8hpp.html">ace_crc/crc32_bit.hpp</a>&quot;</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc32__byte_8hpp.html">ace_crc/crc32_byte.hpp</a>&quot;</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc32__nibble_8hpp.html">ace_crc/crc32_nibble.hpp</a>&quot;</span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="crc32__nibblem_8hpp.html">ace_crc/crc32_nibblem.hpp</a>&quot;</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment">// Version format: xxyyzz == &quot;xx.yy.zz&quot;</span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="preprocessor">#define ACE_CRC_VERSION 10101</span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="preprocessor">#define ACE_CRC_VERSION_STRING &quot;1.1.1&quot;</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="acrc16ccitt__bit_8hpp_html"><div class="ttname"><a href="crc16ccitt__bit_8hpp.html">crc16ccitt_bit.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc16ccitt__byte_8hpp_html"><div class="ttname"><a href="crc16ccitt__byte_8hpp.html">crc16ccitt_byte.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc16ccitt__nibble_8hpp_html"><div class="ttname"><a href="crc16ccitt__nibble_8hpp.html">crc16ccitt_nibble.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc16ccitt__nibblem_8hpp_html"><div class="ttname"><a href="crc16ccitt__nibblem_8hpp.html">crc16ccitt_nibblem.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc16modbus__bit_8hpp_html"><div class="ttname"><a href="crc16modbus__bit_8hpp.html">crc16modbus_bit.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc16modbus__byte_8hpp_html"><div class="ttname"><a href="crc16modbus__byte_8hpp.html">crc16modbus_byte.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc16modbus__nibble_8hpp_html"><div class="ttname"><a href="crc16modbus__nibble_8hpp.html">crc16modbus_nibble.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc16modbus__nibblem_8hpp_html"><div class="ttname"><a href="crc16modbus__nibblem_8hpp.html">crc16modbus_nibblem.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc32__bit_8hpp_html"><div class="ttname"><a href="crc32__bit_8hpp.html">crc32_bit.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc32__byte_8hpp_html"><div class="ttname"><a href="crc32__byte_8hpp.html">crc32_byte.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc32__nibble_8hpp_html"><div class="ttname"><a href="crc32__nibble_8hpp.html">crc32_nibble.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc32__nibblem_8hpp_html"><div class="ttname"><a href="crc32__nibblem_8hpp.html">crc32_nibblem.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc8__bit_8hpp_html"><div class="ttname"><a href="crc8__bit_8hpp.html">crc8_bit.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc8__byte_8hpp_html"><div class="ttname"><a href="crc8__byte_8hpp.html">crc8_byte.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc8__nibble_8hpp_html"><div class="ttname"><a href="crc8__nibble_8hpp.html">crc8_nibble.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
<div class="ttc" id="acrc8__nibblem_8hpp_html"><div class="ttname"><a href="crc8__nibblem_8hpp.html">crc8_nibblem.hpp</a></div><div class="ttdoc">Functions and types for CRC checks.</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
